Skip to content

New Features of Mermaid Graph#190

Open
hejny wants to merge 2 commits intomainfrom
feature/mermaid-with-new-features
Open

New Features of Mermaid Graph#190
hejny wants to merge 2 commits intomainfrom
feature/mermaid-with-new-features

Conversation

@hejny
Copy link
Copy Markdown
Member

@hejny hejny commented Dec 15, 2024

No description provided.

@hejny
Copy link
Copy Markdown
Member Author

hejny commented Dec 27, 2024

@hejny hejny requested a review from Copilot March 17, 2025 08:45
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces new features for rendering Mermaid graphs in Promptbook by integrating reserved parameter handling and updating related type imports and markdown examples.

  • Added reserved parameter support in the Mermaid rendering function
  • Updated imports and adjusted file references for consistency
  • Fixed documentation by adding a dedicated Knowledge section in the markdown example

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
src/conversion/prettify/renderPromptbookMermaid.ts Implements reserved parameter support and updates mermaid rendering
examples/pipelines/25-simple-knowledge.book.md Adds a Knowledge section with a note in the pipeline example
src/_packages/types.index.ts Reorders and consolidates type imports
src/conversion/prettify/prettifyPipelineString.ts Updates the import to point to the new renderPromptbookMermaid module
Comments suppressed due to low confidence (2)

src/conversion/prettify/renderPromptbookMermaid.ts:34

  • [nitpick] Using the cast 'really_any' reduces type safety and may be ambiguous; consider using a more precise type if feasible.
const isReservedParameter = RESERVED_PARAMETER_NAMES.includes(parameterName as really_any);

src/conversion/prettify/renderPromptbookMermaid.ts:38

  • [nitpick] The fallback name 'knowledge' may be too generic; consider using a more descriptive identifier for reserved parameters.
return 'knowledge';

Comment on lines +96 to +97
<!-- <- Note: Knowledge can be passed explicitelly or let it be injected automatically -->

Copy link

Copilot AI Mar 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The word 'explicitelly' is misspelled; consider correcting it to 'explicitly'.

Suggested change
<!-- <- Note: Knowledge can be passed explicitelly or let it be injected automatically -->
<!-- <- Note: Knowledge can be passed explicitly or let it be injected automatically -->

Copilot uses AI. Check for mistakes.
@hejny hejny force-pushed the main branch 4 times, most recently from f8dbde9 to 8e619dc Compare March 2, 2026 11:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants